home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 1 / LSD Compendium Deluxe 1.iso / a / disk / misc / filex11.lha / FileX / Docs / English / FileX.doc < prev    next >
Encoding:
Text File  |  1993-10-22  |  17.3 KB  |  653 lines
  1.                                    
  2.                $VER: FileX Documentation 1.1 (16.10.93)
  3.  
  4.                                    
  5.                      FileX - A binary file editor
  6.  
  7.                   © Copyright 1993 by Klaas Hermanns
  8.  
  9.                     Shareware, all rights reserved.
  10.  
  11. What is FileX?
  12. **************
  13.  
  14.    FileX is a so called binary file editor which offers the following
  15. features:
  16.  
  17.    - The Editwindow can be opened on any public screen and sized to any
  18.      dimension you want.
  19.  
  20.    - Fontsensitivity
  21.  
  22.    - Locale-support if you have OS 2.1 or higher.  (Englisch and German
  23.      catalogs available at the moment)
  24.  
  25.    - Undo and Redo (only limited to your free memory)
  26.  
  27.    - Search and replace
  28.  
  29.    - Extensive blockfunctions
  30.  
  31.    - Clipboardsupport
  32.  
  33.    - ARexxport with more than 66 commands and commandshell
  34.  
  35.    - Printing as hexdump
  36.  
  37.    - `Grab memory' to show and modify memory
  38.  
  39.    - AppWindow. If FileX runs on the workbench, icons can be moved onto
  40.      the FileX window and the related file will be loaded automatically.
  41.  
  42.    - Iconify (AppIcon)
  43.  
  44.    - Moreover, FileX will be developed further permanently...
  45.  
  46. Getting started
  47. ***************
  48.  
  49. Getting started from workbench
  50. ==============================
  51.  
  52.    Starting FileX from the workbench, the following tooltypes will be
  53. interrogated:
  54.  
  55. PUBSCREEN
  56.      Name of a public screen on which FileX shall be opened on.  If
  57.      this tooltype is not specified, FileX will open a window on the
  58.      standard public screen.
  59.  
  60. PORTNAME
  61.      Name of the FileX arexxport. If the port with the specified name
  62.      does already exist, the program automatically adds a number to the
  63.      name and increases it until a non-existing portname is found.
  64.      (`NAME'->`NAME.1'->`NAME.2'). Standardname: `FILEX'.
  65.  
  66. STARTUP
  67.      Name of an arexxscript that will be executed right at the start.
  68.  
  69. SETTINGS
  70.      Name of the Settingsfile to be loaded at the beginning.  If there
  71.      is no name specified, the program tries to open the file
  72.      `FileX.prefs' in the current directory. If that fails,
  73.      `ENVARC:FileX/FileX.prefs' will be tried to open.  If this file
  74.      could not be opened, too, FileX uses the internal settings.
  75.  
  76. COMMANDS
  77.      Name of the arexxcommandsettings. If this tooltype is not
  78.      specified, FileX tries to open `FileXARexxCommands.prefs' from the
  79.      current directory. When that fails, the file
  80.      `ENVARC:FileX/FileXARexxCommands.prefs' will be opened. If this
  81.      file doesn't exist, too, the arexxcommands will remain unset.
  82.  
  83. LANGUAGE
  84.      Specifies the language that should be used in the programm.  By
  85.      default the language from the Workbench Preferences is used.
  86.  
  87. FILE
  88.      A filename that shall be opened right after starting FileX.
  89.  
  90. How to start from CLI
  91. =====================
  92.  
  93.    Following arguments will be checked:
  94.  
  95. PUBSCREEN/K
  96. PORTNAME/K
  97. STARTUP/K
  98. SETTINGS/K
  99. COMMANDS/K
  100.      These tooltypes correspond to the ones for the workbench start.
  101.  
  102. SYNC/S
  103.      This tooltype forces FileX not to detach from Shell.
  104.  
  105. The menus
  106. *********
  107.  
  108. Project
  109. =======
  110.  
  111. New...
  112.      Removes the current file from memory.
  113.  
  114. Open...
  115.      A requester appears to choose a new file to edit.
  116.  
  117. Save
  118.      Saves the current file with its current name. A filerequester will
  119.      be opened if no name has been specified.
  120.  
  121. Save As...
  122.      Saves the current file with a new name.
  123.  
  124. Grab memory
  125.      Opens the `Grab memory'-requester, which allows to show and modify
  126.      memory.
  127.  
  128. Print
  129.      Prints the whole file as hexdump form.
  130.  
  131. Iconify
  132.      Iconifies FileX. The window will be closed and the FileX icon
  133.      appears on the workbench. By double-clicking on this icon or
  134.      moving an other icon over it, FileX will be reactivated again.
  135.  
  136. About...
  137.      Some nice and important informations about FileX.
  138.  
  139. Quit...
  140.      Leaves the program.
  141.  
  142. Edit
  143. ====
  144.  
  145. Mark Block
  146.      Switches block-marking on/off.
  147.  
  148. Cut
  149.      Cuts the current marked block out of the file and copies it into
  150.      the blockbuffer.
  151.  
  152. Copy
  153.      Copies the current marked block into the blockbuffer.
  154.  
  155. Fill
  156.      Fills the current block. A `fill-requester' appears to specify the
  157.      fill-characters, numbers etc.
  158.  
  159. Paste
  160.      Overwrites the file beginning at the current cursorposition with
  161.      the block from the blockbuffer. If this block is longer than the
  162.      rest of the current file, a requester will appear and ask if its
  163.      okay to copy the block anyway.
  164.  
  165. Insert
  166.      Inserts (again beginning at the current cursor position) the block
  167.      from the blockbuffer to the file. As a result, the file will
  168.      become larger.
  169.  
  170. Append
  171.      Adds the block from the blockbuffer to the end of the file.
  172.  
  173. Print
  174.      Prints the block from the blockbuffer as hexdump.
  175.  
  176. Load block...
  177.      Loads a block into the blockbuffer.
  178.  
  179. Save block...
  180.      Saves a block from the blockbuffer as a new file.
  181.  
  182. Load block from clip
  183.      Copies the current content of the clipboard into the blockbuffer.
  184.  
  185. Save block to clip
  186.      Copies the block from the blockbuffer into the clipboard.
  187.  
  188. Undo
  189.      Executes Undo once. The last changes will be re-set.
  190.  
  191. Redo
  192.      Executes Redo once. The last UNDO will be re-set.
  193.  
  194. Edit Ascii
  195.      Switches between Ascii- and Hex-edit.
  196.  
  197. Editable File
  198.      Switches between editable and non-editable file.
  199.  
  200. Search&Replace
  201. ==============
  202.  
  203. Search...
  204.      Opens a `Search'-requester to search an Ascii- or Hex-string.
  205.  
  206. Search and replace..
  207.      Opens a `Search and replace'-requester to search and replace an
  208.      Ascii- or Hex-string.
  209.  
  210. Search(and replace) next
  211.      Repeats the last search (and replace) operation towards the end of
  212.      file.
  213.  
  214. Search(and replace) previous
  215.      Repeats the last search (and replace) operation towards the
  216.      beginning of file.
  217.  
  218. Settings
  219. ========
  220.  
  221. Adjust Windowsize
  222.      Adjusts the windowsize to the size of the displaybevelboxes.
  223.  
  224. Display
  225.      Defines which translationtable is being used to display the Ascii
  226.      characters:
  227.  
  228.     Characters
  229.           Only letters will be shown. The rest is filled with spaces.
  230.  
  231.     ASCII ($20-$7F)
  232.           Only show Hex $20-$7f.
  233.  
  234.     all
  235.           All Characters and the related Ascii-characters will be shown.
  236.  
  237.     User defined
  238.           Use a self-defined translationtable to display.
  239.  
  240.     Load...
  241.           Load this defined translationstable. A 256 bytes-file will be
  242.           loaded which assings every byte an Ascii character.
  243.  
  244. Font...
  245.      Opens a fontrequester to choose a font.
  246.  
  247. Screen
  248.      Definitions of the screen FileX shall be opened on:
  249.  
  250.     Default public
  251.           The default public screen.
  252.  
  253.     Workbench
  254.           The workbench screen.
  255.  
  256.     Public...
  257.           A public screen. A requester to choose it appears.
  258.  
  259.     Own public...
  260.           An own public screen. A requester to choose the screenmode
  261.           appears.
  262.  
  263. Palette...
  264.      Opens a paletterequester to set the colors. Requires
  265.      reqtools.library!
  266.  
  267. Miscellaneous...
  268.      Opens a `Miscellaneous'-requester to define some other things for
  269.      FileX.
  270.  
  271. Load Settings...
  272.      Loads a settingsfile.
  273.  
  274. Save Settings
  275.      Saves the settings under the current name.
  276.  
  277. Save Settings As...
  278.      Saves the settings under a new name.
  279.  
  280. Move
  281. ====
  282.  
  283. Jump to byte...
  284.      Moves the cursor to an defined position in the file.
  285.  
  286. Mark location...
  287.      A mark will be set to the current cursor position. A requester
  288.      asks which number that mark shall be (1-10 possible).
  289.  
  290. Jump to mark...
  291.      After typing the number (1-10) into the appering requester, the
  292.      cursor will be set to the stored position.
  293.  
  294. ARexx
  295. =====
  296.  
  297. Command shell...
  298.      Opens a command shell. Within this shell you may give easy
  299.      arexxcommands to FileX. The result(s) will be displayed at once.
  300.  
  301. Execute command...
  302.      Executes an arexxscript. Again a requester to choose the name will
  303.      be opened.
  304.  
  305. Assign command...
  306.      An arexxscript will be assigned to one of the 10 menuitems.  One
  307.      of the 10 menuitems will be assigned an arexxscript.  A
  308.      filerequester to choose the name and another requester to chose
  309.      the number (0-9) appear.
  310.  
  311. Empty command #[0-9]
  312.      10 Menuitems to be filled with arexxscripts that shall be quickly
  313.      executable.
  314.  
  315. Load commands...
  316.      Loads a settingsfile for the arexxscripts. If the files
  317.      `FileXARexxCommands.prefs' and
  318.      `ENVARC:FileX/FileXARexxCommands.prefs' could not be found, the
  319.      arexxcommands remain unset.
  320.  
  321. Save commands
  322.      Saves the commands under the current name.
  323.  
  324. Save commands as...
  325.      Saves the commands under a new name.
  326.  
  327. The requesters
  328. **************
  329.  
  330.    Every requester in FileX can be left either by pressing ESC or
  331. RETURN. ESC has got the same effect as `Cancel' while RETURN means
  332. `Okay'.
  333.  
  334. Changes
  335. =======
  336.  
  337.    This requester appears every time when data may be lost by mistake,
  338. e.g. if the current file has been modified but not saved so far.  There
  339. are three possibilities to continue:
  340.  
  341. Save First
  342.      Before going on, the current file has to be saved.
  343.  
  344. Continue
  345.      Continues with the chosen operation. The current file with all its
  346.      changes will be lost forever.
  347.  
  348. Cancel
  349.      The chosen operation will be cancelled.
  350.  
  351. Fill
  352. ====
  353.  
  354.    In the `Fill'-requester you can set the pattern for `Edit/Fill':
  355.  
  356. String
  357.      The text to fill with.
  358.  
  359. Hex
  360.      A number of Hex-values to fill with.
  361.  
  362. Fill
  363.      The current marked block will be filled.
  364.  
  365. Grab memory
  366. ===========
  367.  
  368.    With the `Grab memory' option, a memory range can be displayed and
  369. modified. A requester needs start- and endposition of the memory to be
  370. shown.
  371.  
  372. Start
  373.      Startaddress (hexadecimal value).
  374.  
  375. End
  376.      Endaddress (hexadecimal value).
  377.  
  378. Grab
  379.      Displays the memory.
  380.  
  381. Miscellaneous
  382. =============
  383.  
  384.    The `Miscellaneous'-requester serves to set some various options:
  385.  
  386. Alt-Jump
  387.      Number of lines to move the cursor when pressing alt + cursor up/
  388.      cursor down.
  389.  
  390. Scrollborder
  391.      Distance to the upper/lower border when the display shall be
  392.      scrolled
  393.  
  394. Max Undo Level
  395.      Defines the maximum undos.
  396.  
  397. Max Undo Mem
  398.      Maximum of memory to be available for the UNDO/REDO option.
  399.  
  400. Clipboard unit
  401.      The clipboardunit to be used for the blockfunctions.
  402.  
  403. Programm priority
  404.      The program's priority. Useful are usually values between -20 and
  405.      20.
  406.  
  407. Use `asl.library'
  408.      If set, the `asl.library' will be used for file- and fontrequester
  409.      and the `intuition.library' for the standard requester. Useally,
  410.      the `reqtools.library' is used for all requesters.
  411.  
  412. Overwrite
  413.      Activating this option means that files with the same name will be
  414.      overwritten without a possibility to cancel this.
  415.  
  416. Commandshellwindow
  417.      Settings for the commandshelwindow.
  418.  
  419. Commandwindow
  420.      Settings for the window to be opened when executing arexxscripts.
  421.  
  422. Display
  423.      This defines in which form the file shall be diplayed. It can be
  424.      chosen between Hex- and Ascii-display.
  425.  
  426. Spaces
  427.      Here its possible to choose how many Bytes shall be shown as a
  428.      block. You may specify byte, word and longword blocks. It is also
  429.      possible to define no spaces between the blocks.
  430.  
  431. Search
  432. ======
  433.  
  434.    The `Search'-requester is necessary to specify a (hex-)string which
  435. shall be searched with the following options.
  436.  
  437. String
  438.      The text to search for.
  439.  
  440. Hex
  441.      A hexadecimal string to search for. This field allows only hex
  442.      characters from `0-9' as well as `A-F'. You may set spaces between
  443.      two hex strings, like here : 46494C4558 0a . Other characters will
  444.      not be accepted.
  445.  
  446. casesensitiv
  447.      If this gadget is set, FileX will search case-sensitive, that
  448.      means `A' is NOT equal to `a'.
  449.  
  450. wildcards
  451.      If set, the question mark (`?') can be used as pattern.
  452.  
  453. Next <
  454.      Searches a (hex-)string towards the end of a file.
  455.  
  456. Previous >
  457.      Searches a (hex-)string towards the beginning of a file.
  458.  
  459. Search and Relpace
  460. ==================
  461.  
  462.    The `Search and replace'-requester is almost equal to the search
  463. requester, but two more stringgadgets make it possible to search AND
  464. replace a (hex-)string in one turn.
  465.  
  466. The arexxport
  467. *************
  468.  
  469.    FileX has got an arexxport with more than 66 commands. The
  470. documentation about that feature can be found in the file
  471. `FileXARexx.doc'. Some example programs are stored in the arexx
  472. directory.
  473.  
  474. Already scheduled for the next version:
  475. ***************************************
  476.  
  477.    - Onlinehelp
  478.  
  479.    - XPK support
  480.  
  481.    - Multi-edit: a couple of files editable at the same time.
  482.  
  483. Please note:
  484. ************
  485.  
  486.    The filerequester, fontrequester, screemoderequester and the
  487. paletterequester as well as all other requesters are performed using
  488. the `reqtools.library', which is copyrighted © bei Nico François.
  489.  
  490.    The program `ARexxBox' by Michael Balzer was used to create the
  491. basis of the arexxport.
  492.  
  493. Words of thanks
  494. ***************
  495.  
  496. Benjamin Schörner
  497.      for his existence and betatesting.
  498.  
  499. Robert Gorthmanns
  500.      for the manual translations, betatesting, comments and suggestions.
  501.  
  502. Thomas Hornik
  503.      for betatesting, comments and suggestions.
  504.  
  505. Reinhard Geisler
  506.      for the COCUNI( +49 2832 80861 ), which is doubtless the best
  507.      mailbox at the whole `Niederrhein'.
  508.  
  509. Michael Balzer
  510.      for his ARexxBox.
  511.  
  512. Nico François
  513.      for his `reqtools.library'.
  514.  
  515. SAS
  516.      for their great C development system.
  517.  
  518. License
  519. *******
  520.  
  521.    The copyright for FileX remains by the author in any form!
  522.  
  523.    FileX is *NOT* public domain! FileX is shareware. If you use this
  524. program longer than a period of TWO weeks, you must register. A
  525. registration costs 20 DM or 15 US Dollar. You will then get a
  526. registered version of FileX and one free update. This registered
  527. version may be used by only person except you have a special permission
  528. of the author.
  529.  
  530.    The unregistered version has no restrictions to the registered at the
  531. moment, but if there will be only a few people sending back a
  532. registration, the next version will indeed have some restrictions.
  533.  
  534.    To register, fill in the orderform file called `FileX.reg', which is
  535. included in this archive. You may send it back by normal mail or e-mail.
  536. E-mail is only possible if you transfer the money to me.
  537.  
  538.    You may also send me the following things (instead of the money),
  539. and you will also receive a registrated version of FileX:
  540.  
  541.    - Records, videos and books by or about SUPERTRAMP or Roger Hodgson.
  542.  
  543.    - M*A*S*H-videos.
  544.  
  545.    - At least 10 postcards from different places.
  546.  
  547. Distribution
  548. ************
  549.  
  550.    The registered version of FileX must NOT be spread in ANY form.
  551.  
  552.    The unregistered version may only be spread if the following files
  553. are included to the FileX archive:
  554.  
  555.      FileX.info
  556.      FileX/ARexx/FindVersion.FileX
  557.      FileX/ARexx/Info.FileX
  558.      FileX/Catalogs/Deutsch/FileX.catalog
  559.      FileX/Catalogs/FileXCats.lha
  560.      FileX/Docs.info
  561.      FileX/Docs/Deutsch.info
  562.      FileX/Docs/Deutsch/FileX.dok
  563.      FileX/Docs/Deutsch/FileX.dok.info
  564.      FileX/Docs/Deutsch/FileX.guide
  565.      FileX/Docs/Deutsch/FileX.guide.info
  566.      FileX/Docs/Deutsch/FileX.reg
  567.      FileX/Docs/Deutsch/FileX.reg.info
  568.      FileX/Docs/Deutsch/FileXARexx.dok
  569.      FileX/Docs/Deutsch/FileXARexx.dok.info
  570.      FileX/Docs/Deutsch/FileXARexx.guide
  571.      FileX/Docs/Deutsch/FileXARexx.guide.info
  572.      FileX/Docs/English.info
  573.      FileX/Docs/English/FileX.doc
  574.      FileX/Docs/English/FileX.doc.info
  575.      FileX/Docs/English/FileX.guide
  576.      FileX/Docs/English/FileX.guide.info
  577.      FileX/Docs/English/FileX.reg
  578.      FileX/Docs/English/FileX.reg.info
  579.      FileX/Docs/English/FileXARexx.doc
  580.      FileX/Docs/English/FileXARexx.doc.info
  581.      FileX/Docs/English/FileXARexx.guide
  582.      FileX/Docs/English/FileXARexx.guide.info
  583.      FileX/FileX
  584.      FileX/FileX.020
  585.      FileX/FileX.020.info
  586.      FileX/FileX.info
  587.      FileX/Install.info
  588.      FileX/Install/Deutsch.info
  589.      FileX/Install/English.info
  590.      FileX/Install/Install
  591.      FileX/Install/LiesMich
  592.      FileX/Install/LiesMich.info
  593.      FileX/Install/ReadMe
  594.      FileX/Install/ReadMe.info
  595.  
  596.    As long as no file is missing or modified in any way, this archive
  597. of FileX may be spread on disks or per e-mail. It is not allowed to
  598. demand more than 5 DM (or the same amount in your country's currency)
  599. for this program.
  600.  
  601.    Moreover, you may not use FileX for commercial purposes without a
  602. written permission from the author.
  603.  
  604.    FileX has been conscientiously tested, so it *should* work properly.
  605. Please note that the author can *NOT* be held responsible for *ANY*
  606. kind of bugs.
  607.  
  608. Localization
  609. ************
  610.  
  611.    Since Version 1.1 its possible to localize FileX. This feature
  612. requires at least OS 2.1 or higher. This means, that all texts used in
  613. the program can be translated and used instead of the english. The
  614. required Catalogdescription and -translationfiles can be found in the
  615. `Catalogs' directory. At the moment there is only a translation for
  616. german users. If someone translates the texts into his/her language, I
  617. would be very pleased to get the corresponding Catalogtranslationfile.
  618. So I can include it in the next version.
  619.  
  620. Contactaddress:-)
  621. *****************
  622.  
  623.    For bugreports!, postcards, suggestions, new ideas, problems, gifts
  624. or any kind of stuff, I can be reached under the following addresses:
  625.  
  626.      Klaas Hermanns
  627.      Weberstraße 42
  628.      47533 Kleve
  629.      Germany
  630.      
  631.      Usenet: dalton@cocuni.GUN.de
  632.      Z-Netz: DALTON@COCUNI.ZER
  633.      
  634.      Acc. 539 7088, Bank Code 324 500 00, Sparkasse Kleve.
  635.  
  636. History
  637. *******
  638.  
  639.    What's new in Version...
  640.  
  641.    V1.1:
  642.    - Localesupport (English/German)
  643.  
  644.    - The window's width can finally be varied.
  645.  
  646.    - In additon to the Hex/Ascii display, you may now display Hex or
  647.      Ascii ONLY, too.
  648.  
  649.    - In Hex-display-mode, you can choose how many Bytes shall be shown
  650.      as a block. You may specify byte, word and longword blocks. It is
  651.      also possible to define no spaces between the blocks.
  652.  
  653.